home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / complib / chbevx.z / chbevx
Encoding:
Text File  |  1998-10-30  |  7.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHBBBBEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCHHHHBBBBEEEEVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHBEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian band matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHBEVX( JOBZ, RANGE, UPLO, N, KD, AB, LDAB, Q, LDQ, VL, VU,
  14.                         IL, IU, ABSTOL, M, W, Z, LDZ, WORK, RWORK, IWORK,
  15.                         IFAIL, INFO )
  16.  
  17.          CHARACTER      JOBZ, RANGE, UPLO
  18.  
  19.          INTEGER        IL, INFO, IU, KD, LDAB, LDQ, LDZ, M, N
  20.  
  21.          REAL           ABSTOL, VL, VU
  22.  
  23.          INTEGER        IFAIL( * ), IWORK( * )
  24.  
  25.          REAL           RWORK( * ), W( * )
  26.  
  27.          COMPLEX        AB( LDAB, * ), Q( LDQ, * ), WORK( * ), Z( LDZ, * )
  28.  
  29. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  30.      CHBEVX computes selected eigenvalues and, optionally, eigenvectors of a
  31.      complex Hermitian band matrix A.  Eigenvalues and eigenvectors can be
  32.      selected by specifying either a range of values or a range of indices for
  33.      the desired eigenvalues.
  34.  
  35.  
  36. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  37.      JOBZ    (input) CHARACTER*1
  38.              = 'N':  Compute eigenvalues only;
  39.              = 'V':  Compute eigenvalues and eigenvectors.
  40.  
  41.      RANGE   (input) CHARACTER*1
  42.              = 'A': all eigenvalues will be found;
  43.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  44.              found; = 'I': the IL-th through IU-th eigenvalues will be found.
  45.  
  46.      UPLO    (input) CHARACTER*1
  47.              = 'U':  Upper triangle of A is stored;
  48.              = 'L':  Lower triangle of A is stored.
  49.  
  50.      N       (input) INTEGER
  51.              The order of the matrix A.  N >= 0.
  52.  
  53.      KD      (input) INTEGER
  54.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  55.              the number of subdiagonals if UPLO = 'L'.  KD >= 0.
  56.  
  57.      AB      (input/output) COMPLEX array, dimension (LDAB, N)
  58.              On entry, the upper or lower triangle of the Hermitian band
  59.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHBBBBEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCHHHHBBBBEEEEVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.              column of A is stored in the j-th column of the array AB as
  75.              follows:  if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-
  76.              kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  77.              j<=i<=min(n,j+kd).
  78.  
  79.              On exit, AB is overwritten by values generated during the
  80.              reduction to tridiagonal form.
  81.  
  82.      LDAB    (input) INTEGER
  83.              The leading dimension of the array AB.  LDAB >= KD + 1.
  84.  
  85.      Q       (output) COMPLEX array, dimension (LDQ, N)
  86.              If JOBZ = 'V', the N-by-N unitary matrix used in the reduction to
  87.              tridiagonal form.  If JOBZ = 'N', the array Q is not referenced.
  88.  
  89.      LDQ     (input) INTEGER
  90.              The leading dimension of the array Q.  If JOBZ = 'V', then LDQ >=
  91.              max(1,N).
  92.  
  93.      VL      (input) REAL
  94.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  95.              the interval to be searched for eigenvalues. VL < VU.  Not
  96.              referenced if RANGE = 'A' or 'I'.
  97.  
  98.      IL      (input) INTEGER
  99.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  100.              order) of the smallest and largest eigenvalues to be returned.  1
  101.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  102.              referenced if RANGE = 'A' or 'V'.
  103.  
  104.      ABSTOL  (input) REAL
  105.              The absolute error tolerance for the eigenvalues.  An approximate
  106.              eigenvalue is accepted as converged when it is determined to lie
  107.              in an interval [a,b] of width less than or equal to
  108.  
  109.              ABSTOL + EPS *   max( |a|,|b| ) ,
  110.  
  111.              where EPS is the machine precision.  If ABSTOL is less than or
  112.              equal to zero, then  EPS*|T|  will be used in its place, where
  113.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  114.              AB to tridiagonal form.
  115.  
  116.              Eigenvalues will be computed most accurately when ABSTOL is set
  117.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  118.              this routine returns with INFO>0, indicating that some
  119.              eigenvectors did not converge, try setting ABSTOL to
  120.              2*SLAMCH('S').
  121.  
  122.              See "Computing Small Singular Values of Bidiagonal Matrices with
  123.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  124.              Working Note #3.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHBBBBEEEEVVVVXXXX((((3333FFFF))))                                                          CCCCHHHHBBBBEEEEVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      M       (output) INTEGER
  141.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  142.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  143.  
  144.      W       (output) REAL array, dimension (N)
  145.              The first M elements contain the selected eigenvalues in
  146.              ascending order.
  147.  
  148.      Z       (output) COMPLEX array, dimension (LDZ, max(1,M))
  149.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  150.              the orthonormal eigenvectors of the matrix A corresponding to the
  151.              selected eigenvalues, with the i-th column of Z holding the
  152.              eigenvector associated with W(i).  If an eigenvector fails to
  153.              converge, then that column of Z contains the latest approximation
  154.              to the eigenvector, and the index of the eigenvector is returned
  155.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  156.              user must ensure that at least max(1,M) columns are supplied in
  157.              the array Z; if RANGE = 'V', the exact value of M is not known in
  158.              advance and an upper bound must be used.
  159.  
  160.      LDZ     (input) INTEGER
  161.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  162.              'V', LDZ >= max(1,N).
  163.  
  164.      WORK    (workspace) COMPLEX array, dimension (N)
  165.  
  166.      RWORK   (workspace) REAL array, dimension (7*N)
  167.  
  168.      IWORK   (workspace) INTEGER array, dimension (5*N)
  169.  
  170.      IFAIL   (output) INTEGER array, dimension (N)
  171.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  172.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  173.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  174.              is not referenced.
  175.  
  176.      INFO    (output) INTEGER
  177.              = 0:  successful exit
  178.              < 0:  if INFO = -i, the i-th argument had an illegal value
  179.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  180.              indices are stored in array IFAIL.
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.